Xceed .NET Libraries Documentation
Xceed.Tar Assembly / Xceed.Tar Namespace / QuickTar Class / Tar Method / Tar(String,Boolean,Boolean,Boolean,String[]) Method
The full path of the Tar archive. Cannot be empty.
Boolean value indicating whether existing files should be replaced in the destination Tar archive.
Boolean value indicating whether files contained within sub-folders of filesToTar should be added to the Tar archive.
Boolean value indicating whether the directory structure should be preserved in the destination Tar archive.
The list of file paths to add to the Tar archive. Must contain at least one file.


In This Topic
    Tar(String,Boolean,Boolean,Boolean,String[]) Method
    In This Topic
    Archives the specified files in the specified Tar archive, specifying whether existing files should be replaced and paths should be preserved, and whether the operation should be done recursively.
    Syntax
    'Declaration
     
    
    Public Overloads Shared Sub Tar( _
       ByVal tarFileName As String, _
       ByVal replaceExistingFiles As Boolean, _
       ByVal recursive As Boolean, _
       ByVal preservePaths As Boolean, _
       ByVal ParamArray filesToTar() As String _
    ) 
    'Usage
     
    
    Dim tarFileName As String
    Dim replaceExistingFiles As Boolean
    Dim recursive As Boolean
    Dim preservePaths As Boolean
    Dim filesToTar() As String
     
    QuickTar.Tar(tarFileName, replaceExistingFiles, recursive, preservePaths, filesToTar)

    Parameters

    tarFileName
    The full path of the Tar archive. Cannot be empty.
    replaceExistingFiles
    Boolean value indicating whether existing files should be replaced in the destination Tar archive.
    recursive
    Boolean value indicating whether files contained within sub-folders of filesToTar should be added to the Tar archive.
    preservePaths
    Boolean value indicating whether the directory structure should be preserved in the destination Tar archive.
    filesToTar
    The list of file paths to add to the Tar archive. Must contain at least one file.
    Remarks
    This implementation of Tar is fully read/write compatible with the USTAR format. It is read compatible with GNU Tar archives whose entries do not use the header extensions of this format.
    Supported Frameworks

    .NET: net5.0, net5.0-windows, net6.0, net6.0-macos, net6.0-windows, net7.0, net7.0-macos, net7.0-windows, net8.0, net8.0-browser, net8.0-macos, net8.0-windows, net9.0, net9.0-browser, net9.0-macos, net9.0-windows, net10.0, net10.0-browser, net10.0-macos, net10.0-windows.

    .NET Standard: netstandard2.0, netstandard2.1

    .NET Framework: net20, net35, net40, net403, net45, net451, net452, net46, net461, net462, net463, net47, net471, net472, net48, net481.

    See Also